<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Plot distribution of data among residents at sites vs reference area (US, etc.) — plot_vs_us • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Plot distribution of data among residents at sites vs reference area (US, etc.) — plot_vs_us"><meta name="description" content="Visualize indicator values (scores) as distributed across places"><meta property="og:description" content="Visualize indicator values (scores) as distributed across places"><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/USEPA/EJAM/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>Plot distribution of data among residents at sites vs reference area (US, etc.)</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/plot_boxplot_vs_ref.R" class="external-link"><code>R/plot_boxplot_vs_ref.R</code></a></small>
      <div class="d-none name"><code>plot_vs_us.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Visualize indicator values (scores) as distributed across places</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">plot_vs_us</span><span class="op">(</span></span>
<span>  bysite <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  varname <span class="op">=</span> <span class="st">"pctlowinc"</span>,</span>
<span>  type <span class="op">=</span> <span class="st">"ggplot"</span>,</span>
<span>  refarealabel <span class="op">=</span> <span class="st">"All Blockgroups Nationwide"</span>,</span>
<span>  siteslabel <span class="op">=</span> <span class="st">"At Sites Analyzed"</span>,</span>
<span>  siteidlabel <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  refdata <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  nsample <span class="op">=</span> <span class="fl">5000</span>,</span>
<span>  fix_pctcols <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  colorfills <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"lightblue"</span>, <span class="st">"yellow"</span><span class="op">)</span>,</span>
<span>  box.cex.ref <span class="op">=</span> <span class="fl">0.6</span>,</span>
<span>  box.cex.here <span class="op">=</span> <span class="fl">2.2</span>,</span>
<span>  box.pch.ref <span class="op">=</span> <span class="fl">20</span>,</span>
<span>  box.pch.here <span class="op">=</span> <span class="fl">2</span>,</span>
<span>  <span class="va">...</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-bysite">bysite<a class="anchor" aria-label="anchor" href="#arg-bysite"></a></dt>
<dd><p>table of results from ejamit()$results_bysite, like testoutput_ejamit_1000pts_1miles$results_bysite</p></dd>


<dt id="arg-varname">varname<a class="anchor" aria-label="anchor" href="#arg-varname"></a></dt>
<dd><p>name of column in bysite, like  "Demog.Index"</p></dd>


<dt id="arg-type">type<a class="anchor" aria-label="anchor" href="#arg-type"></a></dt>
<dd><p>"box", "plotly", or "ggplot"</p></dd>


<dt id="arg-refarealabel">refarealabel<a class="anchor" aria-label="anchor" href="#arg-refarealabel"></a></dt>
<dd><p>e.g., "All blockgroups in this State"</p></dd>


<dt id="arg-siteslabel">siteslabel<a class="anchor" aria-label="anchor" href="#arg-siteslabel"></a></dt>
<dd><p>e.g., "At Avg. Site Analyzed"</p></dd>


<dt id="arg-siteidlabel">siteidlabel<a class="anchor" aria-label="anchor" href="#arg-siteidlabel"></a></dt>
<dd><p>vector of text one per site to show if type 'box'</p></dd>


<dt id="arg-refdata">refdata<a class="anchor" aria-label="anchor" href="#arg-refdata"></a></dt>
<dd><p>reference area dataset, like blockgroupstats, but must have columns
named 'pop' and varname. e.g., refdata = blockgroupstatsST %in% "DE", .(pop, pcthisp)</p></dd>


<dt id="arg-nsample">nsample<a class="anchor" aria-label="anchor" href="#arg-nsample"></a></dt>
<dd><p>to limit dots on plot of ref area like all bg in US</p></dd>


<dt id="arg-colorfills">colorfills<a class="anchor" aria-label="anchor" href="#arg-colorfills"></a></dt>
<dd><p>two colors for boxplot</p></dd>


<dt id="arg-box-cex-ref">box.cex.ref<a class="anchor" aria-label="anchor" href="#arg-box-cex-ref"></a></dt>
<dd><p>use default</p></dd>


<dt id="arg-box-cex-here">box.cex.here<a class="anchor" aria-label="anchor" href="#arg-box-cex-here"></a></dt>
<dd><p>use default</p></dd>


<dt id="arg-box-pch-ref">box.pch.ref<a class="anchor" aria-label="anchor" href="#arg-box-pch-ref"></a></dt>
<dd><p>use default</p></dd>


<dt id="arg-box-pch-here">box.pch.here<a class="anchor" aria-label="anchor" href="#arg-box-pch-here"></a></dt>
<dd><p>description</p></dd>


<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p>passed to boxplot()</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>plots</p>
    </div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>Not population weighted, so it is the distribution across sites not residents.</p>
<p>Could be edited to allow multiple types of sites and/or reference zones
more generally like for ejamit_compare_types_of_places()</p>
    </div>
    <div class="section level2">
    <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
    <div class="dont-index"><p>See <code><a href="plot_boxplot_pctiles.html">plot_boxplot_pctiles()</a></code> for Percentile indicators compared in one plot.
and <code>boxplot_ratios()</code> for an older Ratios plot.
See <code><a href="ejam2barplot.html">ejam2barplot()</a></code>  for Ratio indicators compared in one plot.
See <code>plot_boxplot_vs_ref()</code> for a Raw indicator vs. a reference distribution.</p></div>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span> <span class="co"># \dontrun{</span></span>
<span>  <span class="va">out</span> <span class="op">&lt;-</span> <span class="va">testoutput_ejamit_1000pts_1miles</span></span>
<span>  <span class="co"># ejam2boxplot(out)</span></span>
<span>  <span class="co"># plot_boxplot_vs_ref(out$results_bysite)</span></span>
<span>  <span class="fu">plot_vs_us</span><span class="op">(</span><span class="va">out</span><span class="op">$</span><span class="va">results_bysite</span>, type <span class="op">=</span> <span class="st">'box'</span><span class="op">)</span></span>
<span>  <span class="fu">plot_vs_us</span><span class="op">(</span><span class="va">out</span><span class="op">$</span><span class="va">results_bysite</span>, varname <span class="op">=</span> <span class="st">"pctlingiso"</span>, type <span class="op">=</span>  <span class="st">'box'</span>, ylim<span class="op">=</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0</span>, <span class="fl">20</span><span class="op">)</span><span class="op">)</span></span>
<span>  <span class="fu">plot_vs_us</span><span class="op">(</span><span class="va">out</span><span class="op">$</span><span class="va">results_bysite</span>, varname <span class="op">=</span> <span class="st">"pctlingiso"</span>, type <span class="op">=</span>  <span class="st">'ggplot'</span><span class="op">)</span></span>
<span>  <span class="fu">plot_vs_us</span><span class="op">(</span><span class="va">out</span><span class="op">$</span><span class="va">results_bysite</span>, varname <span class="op">=</span> <span class="st">"pctnhaa"</span>, type <span class="op">=</span>  <span class="st">'ggplot'</span><span class="op">)</span></span>
<span>  <span class="fu">plot_vs_us</span><span class="op">(</span><span class="va">out</span><span class="op">$</span><span class="va">results_bysite</span>, varname <span class="op">=</span> <span class="st">"pctnhaa"</span>, type <span class="op">=</span> <span class="st">'box'</span>, ylim <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0</span>, <span class="fl">20</span><span class="op">)</span><span class="op">)</span></span>
<span>  </span>
<span> <span class="co"># td = testoutput_ejamit_1000pts_1miles$results_bysite</span></span>
<span> <span class="co"># plot_vs_us(, type = 'box')</span></span>
<span> <span class="co"># plot_vs_us(td, varname = "pctlingiso", type =  'box', ylim=c(0,20))</span></span>
<span> <span class="co"># plot_vs_us(td, varname = "pctlingiso", type =  'ggplot')</span></span>
<span> <span class="co"># plot_vs_us(td, varname = "pctnhaa", type =  'ggplot')</span></span>
<span> <span class="co"># plot_vs_us(td, varname = "pctnhaa", type = 'box', ylim = c(0,20))</span></span>
<span> <span class="co"># plot_vs_us(td[td$ST %in% "DE", ], 'pcthisp', refdata = blockgroupstats[ST %in% "DE", .(pop, pcthisp)])</span></span>
<span>  <span class="op">}</span> <span class="co"># }</span></span>
<span>  </span></code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2024</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

